org.eclipse.vtp.framework.webservices.configurations
Class WebServiceCallConfiguration

java.lang.Object
  org.eclipse.vtp.framework.webservices.configurations.WebServiceCallConfiguration

All Implemented Interfaces:

IConfiguration, WebServiceConstants

public class WebServiceCallConfiguration
extends java.lang.Object
implements IConfiguration, WebServiceConstants

A configuration for a web service call.

Author:

Lonnie Pryor

Field Summary

Fields inherited from interface org.eclipse.vtp.framework.webservices.configurations.WebServiceConstants

NAME_ENDPOINT, NAME_INPUT, NAME_LOCATOR, NAME_MAPPING, NAME_NAME, NAME_OPERATION, NAME_PORT, NAME_RESULT_CARDINALITY, NAME_RESULT_NAME, NAME_RESULT_TYPE, NAME_TYPE, NAME_VALUE, NAME_WEB_SERVICE, NAMESPACE_URI

Constructor Summary

WebServiceCallConfiguration()
Creates a new WebServiceCallConfiguration.

Method Summary

void	addInput(WebServiceInputConfiguration input) Adds an input to this call.
void	addMapping(WebServiceMappingConfiguration mapping) Adds a mapping to this query.
WebServiceInputConfiguration[]	getInputs() Returns the inputs specified for the call.
java.lang.String	getLocator() Returns the name of the locator to use.
WebServiceMappingConfiguration[]	getMappings() Returns the mappings specified to the query.
java.lang.String	getOperation() Returns the name of the operation to invoke.
java.lang.String	getPort() Returns the name of the port to use.
java.lang.String	getResultName() Returns the name of the result to populate.
java.lang.String	getResultType() Returns the name of the type of result to create.
java.lang.String	getWebService() Returns the name of the web service to call.
boolean	isResultArray() Returns true if multiple records should be returned.
void	load(org.w3c.dom.Element configurationElement) Loads the configuration information from the specified XML element.
void	removeInput(WebServiceInputConfiguration input) Removes an input from this call.
void	removeMapping(WebServiceMappingConfiguration mapping) Removes a mapping from this query.
void	save(org.w3c.dom.Element configurationElement) Saves the configuration information into the supplied XML element.
void	setLocator(java.lang.String locator) Sets the name of the locator to use.
void	setOperation(java.lang.String operation) Sets the name of the operation to invoke.
void	setPort(java.lang.String port) Sets the name of the port to use.
void	setResultArray(boolean resultArray) Changes the multiple records setting.
void	setResultName(java.lang.String resultName) Sets the name of the result to populate.
void	setResultType(java.lang.String resultType) Sets the name of the type of result to create.
void	setWebService(java.lang.String webService) Sets the name of the web service to call.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebServiceCallConfiguration

public WebServiceCallConfiguration()

Creates a new WebServiceCallConfiguration.

Method Detail

getLocator

public java.lang.String getLocator()

Returns the name of the locator to use.

Returns:

The name of the locator to use.

setLocator

public void setLocator(java.lang.String locator)

Sets the name of the locator to use.

Parameters:

locator - The name of the locator to use.

getWebService

public java.lang.String getWebService()

Returns the name of the web service to call.

Returns:

The name of the web service to call.

setWebService

public void setWebService(java.lang.String webService)

Sets the name of the web service to call.

Parameters:

webService - The name of the web service to call.

getPort

public java.lang.String getPort()

Returns the name of the port to use.

Returns:

The name of the port to use.

setPort

public void setPort(java.lang.String port)

Sets the name of the port to use.

Parameters:

port - The name of the port to use.

getOperation

public java.lang.String getOperation()

Returns the name of the operation to invoke.

Returns:

The name of the operation to invoke.

setOperation

public void setOperation(java.lang.String operation)

Sets the name of the operation to invoke.

Parameters:

operation - The name of the operation to invoke.

getResultName

public java.lang.String getResultName()

Returns the name of the result to populate.

Returns:

The name of the result to populate.

setResultName

public void setResultName(java.lang.String resultName)

Sets the name of the result to populate.

Parameters:

resultName - The name of the result to populate.

getResultType

public java.lang.String getResultType()

Returns the name of the type of result to create.

Returns:

The name of the type of result to create.

setResultType

public void setResultType(java.lang.String resultType)

Sets the name of the type of result to create.

Parameters:

resultType - The name of the type of result to create.

isResultArray

public boolean isResultArray()

Returns true if multiple records should be returned.

Returns:

True if multiple records should be returned.

setResultArray

public void setResultArray(boolean resultArray)

Changes the multiple records setting.

Parameters:

resultArray - True if multiple records should be returned.

getInputs

public WebServiceInputConfiguration[] getInputs()

Returns the inputs specified for the call.

Returns:

The inputs specified for the call.

addInput

public void addInput(WebServiceInputConfiguration input)

Adds an input to this call.

Parameters:

input - The input to add.

removeInput

public void removeInput(WebServiceInputConfiguration input)

Removes an input from this call.

Parameters:

input - The input to remove.

getMappings

public WebServiceMappingConfiguration[] getMappings()

Returns the mappings specified to the query.

Returns:

The mappings specified to the query.

addMapping

public void addMapping(WebServiceMappingConfiguration mapping)

Adds a mapping to this query.

Parameters:

mapping - The mapping to add.

removeMapping

public void removeMapping(WebServiceMappingConfiguration mapping)

Removes a mapping from this query.

Parameters:

mapping - The mapping to remove.

load

public void load(org.w3c.dom.Element configurationElement)

Description copied from interface: IConfiguration

Loads the configuration information from the specified XML element.

Specified by:

load in interface IConfiguration

Parameters:

configurationElement - The element to load the configuration from.

save

public void save(org.w3c.dom.Element configurationElement)

Description copied from interface: IConfiguration

Saves the configuration information into the supplied XML element.

Specified by:

save in interface IConfiguration

Parameters:

configurationElement - The element to save the configuration to.